/*
 * MIT License
 *
 * Copyright (c) 2024-2048 冰羽
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package cn.star.framework.rbac.entity;

import cn.star.framework.annotation.SorterOrder;
import cn.star.framework.entity.AbstractIdEntity;
import cn.star.framework.rbac.core.IRbacResource;
import cn.star.framework.rbac.type.ResourceType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.persistence.UniqueConstraint;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.hibernate.annotations.Comment;

/**
 * 权限<br>
 *
 * @author zhaoweiping
 *     <p style='color: red'>Created on 2024-09-23 11:06:00
 * @since 3.0.0
 */
@Data
@EqualsAndHashCode(callSuper = true)
@Entity
@Table(
    name = "sys_permission",
    uniqueConstraints = {
      @UniqueConstraint(columnNames = {"fk_tenant_id_", "fk_resource_type_", "code_"}),
    })
@org.hibernate.annotations.Table(appliesTo = "sys_permission", comment = "权限")
public class Permission extends AbstractIdEntity {
  /** 资源类型 {@link IRbacResource#getType()} */
  @Column(name = "fk_resource_type_", length = 16, nullable = false)
  @Comment(value = "资源类型")
  @SorterOrder
  private ResourceType resourceType;

  /** 权限名称 */
  @Column(name = "name_", length = 64, nullable = false)
  @Comment(value = "权限名称")
  private String name;

  /** 权限代码 */
  @Column(name = "code_", length = 64, nullable = false)
  @Comment(value = "权限代码")
  private String code;

  /** 描述 */
  @Column(name = "describe_")
  @Comment(value = "描述")
  private String describe;

  /**
   * 是否有权限<br>
   * 作为属性交互使用，不持久化<br>
   */
  @Transient private boolean auth = false;

  /**
   * 关联资源主键
   */
  @Transient private String resourceId;
}
